Koala Plot Core/io.github.koalaplot.core.bar

Package-level declarations

Types

Link copied to clipboard
class AxisSettings

Specifies the settings for an Axis.

Link copied to clipboard
interface BarChartEntry<X, Y>
Link copied to clipboard
Link copied to clipboard
class BulletBuilderScope

A scope for configuring a bullet graph.

Link copied to clipboard
@DslMarker
annotation class BulletGraphDslMarker
Link copied to clipboard
data class BulletGraphScope constructor(scopes: MutableList<BulletBuilderScope> = mutableListOf(), var labelWidth: LabelWidth = VariableFraction(@Suppress("MagicNumber") 0.25f))

A scope for constructing displays that layout and align features among multiple bullet graphs.

Link copied to clipboard
data class DefaultBarChartEntry<X, Y>(val xValue: X, val yMin: Y, val yMax: Y) : BarChartEntry<X, Y>
Link copied to clipboard
data class DefaultVerticalBarPlotEntry<X, Y>(val x: X, val y: VerticalBarPosition<Y>) : VerticalBarPlotEntry<X, Y>

Default implementation of a BarChartEntry.

Link copied to clipboard
Link copied to clipboard
data class DefaultVerticalBarPlotStackedPointEntry<X, Y>(val x: X, val yOrigin: Y, val y: List<Y>) : VerticalBarPlotStackedPointEntry<X, Y>
Link copied to clipboard
data class DefaultVerticalBarPosition<Y>(val yMin: Y, val yMax: Y) : VerticalBarPosition<Y>
Link copied to clipboard
data class Fixed(size: Dp) : LabelWidth

Set the label width as a fixed size in Dp. If the label is smaller than the size it will be right-justified to the graph.

Link copied to clipboard
data class FixedFraction(fraction: Float) : LabelWidth

Set the label width as a fixed fraction of the overall graph width. If the label is smaller than the fixed fraction it will be right-justified to the graph.

Link copied to clipboard
interface GroupedVerticalBarPlotScope<X, Y>

Receiver scope used by GroupedVerticalBarPlot.

Link copied to clipboard
sealed class LabelWidth

Sealed class hierarchy to designate the label area width type and values.

Link copied to clipboard
open class Slot<T>(default: T)

A slot to hold a configurable value in the bullet graph dsl.

Link copied to clipboard
interface StackedVerticalBarPlotScope<X>

Receiver scope used by StackedVerticalBarPlot.

Link copied to clipboard
interface StackedVerticalBarPlotSeriesScope<X>

Scope item to allow adding items to a StackedVerticalBarPlot.

Link copied to clipboard
data class VariableFraction(fraction: Float) : LabelWidth

Set the label width as a variable fraction of the overall graph width. If the label is smaller than the fraction the graph will grow to occupy the available space.

Link copied to clipboard
typealias VerticalBarComposable<E> = @Composable BarScope.(series: Int, index: Int, value: E) -> Unit

Defines a Composable function used to emit a vertical bar. The parameter series is the chart data series index. The parameter index is the element index within the series. The parameter value is the value of the element.

Link copied to clipboard
interface VerticalBarPlotEntry<X, Y>

An interface that defines a data element to be plotted on a Bar chart.

Link copied to clipboard
interface VerticalBarPlotGroupedPointEntry<X, Y>

Represents a set of points for a GroupedVerticalBarPlot.

Link copied to clipboard
interface VerticalBarPlotScope<X, Y>

Scope item to allow adding items to a VerticalBarPlot.

Link copied to clipboard
interface VerticalBarPlotStackedPointEntry<X, Y>

Represents a set of data points for a StackedVerticalBarPlot.

Link copied to clipboard
interface VerticalBarPosition<Y>

An interface that defines the y-axis coordinates for vertical bars on a bar plot.

Functions

Link copied to clipboard
@Composable
fun BulletGraph(modifier: Modifier = Modifier, animationSpec: AnimationSpec<Float> = KoalaPlotTheme.animationSpec, builder: BulletBuilderScope.() -> Unit)

Implementation of a bullet graph as defined in http://www.perceptualedge.com/articles/misc/Bullet_Graph_Design_Spec.pdf.

Link copied to clipboard
@Composable
fun BulletGraphs(modifier: Modifier = Modifier, gap: Dp = KoalaPlotTheme.sizes.gap, animationSpec: AnimationSpec<Float> = KoalaPlotTheme.animationSpec, builder: BulletGraphScope.() -> Unit)

A vertical layout of multiple bullet graphs. Each bullet will equally share the vertical space and be the same height. The left and right edges of all bullets will be aligned horizontally.

Link copied to clipboard
@Composable
fun BarScope.DefaultVerticalBar(color: Color, shape: Shape = RectangleShape, border: BorderStroke? = null)

A simplified DefaultVerticalBar that uses a Solid Color color and default RectangleShape.

@Composable
fun BarScope.DefaultVerticalBar(brush: Brush, modifier: Modifier = Modifier, shape: Shape = RectangleShape, border: BorderStroke? = null, hoverElement: @Composable () -> Unit = {})

A default implementation of a bar for bar charts.

Link copied to clipboard
@Composable
fun DiamondIndicator(color: Color = MaterialTheme.colorScheme.primary, size: Dp)
@Composable
fun DiamondIndicator(color: Color = MaterialTheme.colorScheme.primary, sizeFraction: Float = DefaultSizeFraction)

A diamond-shaped indicator that may be used as a feature marker.

Link copied to clipboard
@Composable
fun <X, Y> XYGraphScope<X, Y>.GroupedVerticalBarPlot(modifier: Modifier = Modifier, maxBarGroupWidth: Float = 0.9f, animationSpec: AnimationSpec<Float> = KoalaPlotTheme.animationSpec, content: GroupedVerticalBarPlotScope<X, Y>.() -> Unit)
@Composable
fun <X, Y, E : VerticalBarPlotGroupedPointEntry<X, Y>> XYGraphScope<X, Y>.GroupedVerticalBarPlot(data: List<E>, modifier: Modifier = Modifier, bar: @Composable BarScope.(dataIndex: Int, groupIndex: Int, entry: E) -> Unit = { i, g, _ -> val colors = remember(data) { generateHueColorPalette(data.maxOf { it.y.size }) } DefaultVerticalBar( brush = SolidColor(colors[g]), modifier = Modifier.fillMaxWidth(KoalaPlotTheme.sizes.barWidth) ) }, maxBarGroupWidth: Float = 0.9f, animationSpec: AnimationSpec<Float> = KoalaPlotTheme.animationSpec)

A Vertical Bar Plot to be used in an XYGraph and that plots multiple series side-by-side.

Link copied to clipboard
@Composable
fun HorizontalBarIndicator(brush: Brush, modifier: Modifier = Modifier, fraction: Float = 1.0f, shape: Shape = RectangleShape, border: BorderStroke? = null)

A default implementation of a bar indicator that can be used for the featured measure or qualitative ranges.

Link copied to clipboard
@Composable
fun LineIndicator(color: Color = MaterialTheme.colorScheme.primary, heightFraction: Float = DefaultSizeFraction, width: Dp = 2.dp)

A line for comparative measure indicators.

Link copied to clipboard
fun solidBar(color: Color, shape: Shape = RectangleShape, border: BorderStroke? = null): @Composable BarScope.() -> Unit

Factory function to create a Composable that emits a solid colored bar.

Link copied to clipboard
@Composable
fun <X> XYGraphScope<X, Float>.StackedVerticalBarPlot(modifier: Modifier = Modifier, barWidth: Float = 0.9f, animationSpec: AnimationSpec<Float> = KoalaPlotTheme.animationSpec, content: StackedVerticalBarPlotScope<X>.() -> Unit)

A Vertical Bar Plot to be used in an XYGraph and that plots multiple series as a stack of bars.

@Composable
fun <X, Y, E : VerticalBarPlotStackedPointEntry<X, Y>> XYGraphScope<X, Y>.StackedVerticalBarPlot(data: List<E>, modifier: Modifier = Modifier, bar: @Composable BarScope.(xIndex: Int, barIndex: Int) -> Unit, barWidth: Float = 0.9f, animationSpec: AnimationSpec<Float> = KoalaPlotTheme.animationSpec)

Composes a stacked vertical bar plot. This is a convenience method which defers to VerticalBarPlot. A stacked bar plot can be also achieved by placing multiple VerticalBarPlots on an io.github.koalaplot.core.xygraph.XYGraph, one for each "layer" of bars.

Link copied to clipboard
@Composable
fun <X, Y, E : BarChartEntry<X, Y>> XYChartScope<X, Y>.VerticalBarChart(series: List<List<E>>, modifier: Modifier = Modifier, bar: VerticalBarComposable<E> = { i, _, _ -> val colors = remember(series.size) { generateHueColorPalette(series.size) } DefaultVerticalBar( brush = SolidColor(colors[i]), modifier = Modifier.fillMaxWidth(KoalaPlotTheme.sizes.barWidth) ) }, stacked: Boolean = false, maxBarGroupWidth: Float = 0.9f, animationSpec: AnimationSpec<Float> = KoalaPlotTheme.animationSpec)

A VerticalBarChart to be used in an XYChart and that can plot multiple series either side-by-side or stacked as a stacked bar chart.

Link copied to clipboard
@Composable
fun <X, Y> XYGraphScope<X, Y>.VerticalBarPlot(defaultBar: @Composable BarScope.() -> Unit = solidBar(Color.Blue), modifier: Modifier = Modifier, barWidth: Float = 0.9f, animationSpec: AnimationSpec<Float> = KoalaPlotTheme.animationSpec, content: VerticalBarPlotScope<X, Y>.() -> Unit)

Creates a Vertical Bar Plot.

@Composable
fun <X, Y, E : VerticalBarPlotEntry<X, Y>> XYGraphScope<X, Y>.VerticalBarPlot(data: List<E>, modifier: Modifier = Modifier, bar: @Composable BarScope.(index: Int) -> Unit, barWidth: Float = 0.9f, animationSpec: AnimationSpec<Float> = KoalaPlotTheme.animationSpec)

A VerticalBarPlot to be used in an XYGraph and that plots data points as vertical bars.

@Composable
fun <X> XYGraphScope<X, Float>.VerticalBarPlot(xData: List<X>, yData: List<Float>, modifier: Modifier = Modifier, bar: @Composable BarScope.(index: Int) -> Unit, barWidth: Float = 0.9f, animationSpec: AnimationSpec<Float> = KoalaPlotTheme.animationSpec)

A VerticalBarPlot to be used in an XYGraph and that plots a single series of data points as vertical bars.

Link copied to clipboard
fun <X, Y> verticalBarPlotEntry(x: X, yMin: Y, yMax: Y): VerticalBarPlotEntry<X, Y>

Convenience function for creating a VerticalBarPlotEntry.

Link copied to clipboard
fun <Y> verticalBarPosition(yMin: Y, yMax: Y): VerticalBarPosition<Y>

Convenience function for creating a VerticalBarPosition.